Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update concept documentation for 1.0 #2378

Merged
merged 5 commits into from
Sep 30, 2022

Conversation

carolynvs
Copy link
Member

@carolynvs carolynvs commented Sep 26, 2022

What does this change

  • Fill out the Porter Architecture doc pages. Replace the TODO placeholder pages with actual info about porter's buildtime/runtime.
  • Document porter's security features. Add a concept page that explains porter's security features.
  • Add more information to the custom dockerfile page about the non-root user.

https://deploy-preview-2378--porter.netlify.app/architecture/
https://deploy-preview-2378--porter.netlify.app/architecture-buildtime/
https://deploy-preview-2378--porter.netlify.app/architecture-runtime/

https://deploy-preview-2378--porter.netlify.app (scroll down to the block that says security features)
https://deploy-preview-2378--porter.netlify.app/security-features/
https://deploy-preview-2378--porter.netlify.app/bundle/custom-dockerfile/#bundles-do-not-run-as-root (documented running as a non-root user)

What issue does it fix

Closes #1944
Closes #151

Notes for the reviewer

N/A

Checklist

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Reviewer Checklist

  • Comment with /azp run test-porter-release if a magefile or build script was modified
  • Comment with /azp run porter-integration if it's a non-trivial PR

Replace the TODO placeholder pages with actual info about porter's buildtime/runtime.

Signed-off-by: Carolyn Van Slyck <[email protected]>
Add a concept page that explains porter's security features.

Signed-off-by: Carolyn Van Slyck <[email protected]>
@carolynvs carolynvs force-pushed the concept-docs-1.0 branch 2 times, most recently from 8de3a69 to 5469f12 Compare September 28, 2022 15:48
@carolynvs carolynvs marked this pull request as ready for review September 28, 2022 15:52
@carolynvs carolynvs requested a review from iennae September 28, 2022 16:19
@carolynvs carolynvs merged commit e141ea3 into getporter:release/v1 Sep 30, 2022
@carolynvs carolynvs deleted the concept-docs-1.0 branch September 30, 2022 15:25
@github-actions github-actions bot mentioned this pull request Sep 30, 2022
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add security doc page Document how/where mixins are installed
1 participant